home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / Libraries / Berkeley DB 1.8.5a / btree / btree.h < prev   
Encoding:
C/C++ Source or Header  |  1995-10-08  |  14.4 KB  |  391 lines  |  [TEXT/CWIE]
  1. /*-
  2.  * Copyright (c) 1991, 1993, 1994
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * This code is derived from software contributed to Berkeley by
  6.  * Mike Olson.
  7.  *
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  * 2. Redistributions in binary form must reproduce the above copyright
  14.  *    notice, this list of conditions and the following disclaimer in the
  15.  *    documentation and/or other materials provided with the distribution.
  16.  * 3. All advertising materials mentioning features or use of this software
  17.  *    must display the following acknowledgement:
  18.  *    This product includes software developed by the University of
  19.  *    California, Berkeley and its contributors.
  20.  * 4. Neither the name of the University nor the names of its contributors
  21.  *    may be used to endorse or promote products derived from this software
  22.  *    without specific prior written permission.
  23.  *
  24.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34.  * SUCH DAMAGE.
  35.  *
  36.  *    @(#)btree.h    8.11 (Berkeley) 8/17/94
  37.  */
  38.  
  39. /* Macros to set/clear/test flags. */
  40. #define    F_SET(p, f)    (p)->flags |= (f)
  41. #define    F_CLR(p, f)    (p)->flags &= ~(f)
  42. #define    F_ISSET(p, f)    ((p)->flags & (f))
  43.  
  44. #include <mpool.h>
  45.  
  46. #define    DEFMINKEYPAGE    (2)        /* Minimum keys per page */
  47. #define    MINCACHE    (5)        /* Minimum cached pages */
  48. #define    MINPSIZE    (512)        /* Minimum page size */
  49.  
  50. /*
  51.  * Page 0 of a btree file contains a copy of the meta-data.  This page is also
  52.  * used as an out-of-band page, i.e. page pointers that point to nowhere point
  53.  * to page 0.  Page 1 is the root of the btree.
  54.  */
  55. #define    P_INVALID     0        /* Invalid tree page number. */
  56. #define    P_META         0        /* Tree metadata page number. */
  57. #define    P_ROOT         1        /* Tree root page number. */
  58.  
  59. /*
  60.  * There are five page layouts in the btree: btree internal pages (BINTERNAL),
  61.  * btree leaf pages (BLEAF), recno internal pages (RINTERNAL), recno leaf pages
  62.  * (RLEAF) and overflow pages.  All five page types have a page header (PAGE).
  63.  * This implementation requires that values within structures NOT be padded.
  64.  * (ANSI C permits random padding.)  If your compiler pads randomly you'll have
  65.  * to do some work to get this package to run.
  66.  */
  67. #if PRAGMA_ALIGN_SUPPORTED
  68. #pragma options align=mac68k
  69. #endif
  70. typedef struct _page {
  71.     pgno_t    pgno;            /* this page's page number */
  72.     pgno_t    prevpg;            /* left sibling */
  73.     pgno_t    nextpg;            /* right sibling */
  74.  
  75. #define    P_BINTERNAL    0x01        /* btree internal page */
  76. #define    P_BLEAF        0x02        /* leaf page */
  77. #define    P_OVERFLOW    0x04        /* overflow page */
  78. #define    P_RINTERNAL    0x08        /* recno internal page */
  79. #define    P_RLEAF        0x10        /* leaf page */
  80. #define P_TYPE        0x1f        /* type mask */
  81. #define    P_PRESERVE    0x20        /* never delete this chain of pages */
  82.     u_int32_t flags;
  83.  
  84.     indx_t    lower;            /* lower bound of free space on page */
  85.     indx_t    upper;            /* upper bound of free space on page */
  86.     indx_t    linp[1];        /* indx_t-aligned VAR. LENGTH DATA */
  87. } PAGE;
  88.  
  89. /* First and next index. */
  90. #define    BTDATAOFF                            \
  91.     (sizeof(pgno_t) + sizeof(pgno_t) + sizeof(pgno_t) +        \
  92.         sizeof(u_int32_t) + sizeof(indx_t) + sizeof(indx_t))
  93. #define    NEXTINDEX(p)    (((p)->lower - BTDATAOFF) / sizeof(indx_t))
  94.  
  95. /*
  96.  * For pages other than overflow pages, there is an array of offsets into the
  97.  * rest of the page immediately following the page header.  Each offset is to
  98.  * an item which is unique to the type of page.  The h_lower offset is just
  99.  * past the last filled-in index.  The h_upper offset is the first item on the
  100.  * page.  Offsets are from the beginning of the page.
  101.  *
  102.  * If an item is too big to store on a single page, a flag is set and the item
  103.  * is a { page, size } pair such that the page is the first page of an overflow
  104.  * chain with size bytes of item.  Overflow pages are simply bytes without any
  105.  * external structure.
  106.  *
  107.  * The page number and size fields in the items are pgno_t-aligned so they can
  108.  * be manipulated without copying.  (This presumes that 32 bit items can be
  109.  * manipulated on this system.)
  110.  */
  111. #define    LALIGN(n)    (((n) + sizeof(pgno_t) - 1) & ~(sizeof(pgno_t) - 1))
  112. #define    NOVFLSIZE    (sizeof(pgno_t) + sizeof(u_int32_t))
  113.  
  114. /*
  115.  * For the btree internal pages, the item is a key.  BINTERNALs are {key, pgno}
  116.  * pairs, such that the key compares less than or equal to all of the records
  117.  * on that page.  For a tree without duplicate keys, an internal page with two
  118.  * consecutive keys, a and b, will have all records greater than or equal to a
  119.  * and less than b stored on the page associated with a.  Duplicate keys are
  120.  * somewhat special and can cause duplicate internal and leaf page records and
  121.  * some minor modifications of the above rule.
  122.  */
  123. typedef struct _binternal {
  124.     u_int32_t ksize;        /* key size */
  125.     pgno_t    pgno;            /* page number stored on */
  126. #define    P_BIGDATA    0x01        /* overflow data */
  127. #define    P_BIGKEY    0x02        /* overflow key */
  128.     u_char    flags;
  129.     char    bytes[1];        /* data */
  130. } BINTERNAL;
  131.  
  132. /* Get the page's BINTERNAL structure at index indx. */
  133. #define    GETBINTERNAL(pg, indx)                        \
  134.     ((BINTERNAL *)((char *)(pg) + (pg)->linp[indx]))
  135.  
  136. /* Get the number of bytes in the entry. */
  137. #define NBINTERNAL(len)                            \
  138.     LALIGN(sizeof(u_int32_t) + sizeof(pgno_t) + sizeof(u_char) + (len))
  139.  
  140. /* Copy a BINTERNAL entry to the page. */
  141. #define    WR_BINTERNAL(p, size, pgno, flags) {                \
  142.     *(u_int32_t *)p = size;                        \
  143.     p += sizeof(u_int32_t);                        \
  144.     *(pgno_t *)p = pgno;                        \
  145.     p += sizeof(pgno_t);                        \
  146.     *(u_char *)p = flags;                        \
  147.     p += sizeof(u_char);                        \
  148. }
  149.  
  150. /*
  151.  * For the recno internal pages, the item is a page number with the number of
  152.  * keys found on that page and below.
  153.  */
  154. typedef struct _rinternal {
  155.     recno_t    nrecs;            /* number of records */
  156.     pgno_t    pgno;            /* page number stored below */
  157. } RINTERNAL;
  158.  
  159. /* Get the page's RINTERNAL structure at index indx. */
  160. #define    GETRINTERNAL(pg, indx)                        \
  161.     ((RINTERNAL *)((char *)(pg) + (pg)->linp[indx]))
  162.  
  163. /* Get the number of bytes in the entry. */
  164. #define NRINTERNAL                            \
  165.     LALIGN(sizeof(recno_t) + sizeof(pgno_t))
  166.  
  167. /* Copy a RINTERAL entry to the page. */
  168. #define    WR_RINTERNAL(p, nrecs, pgno) {                    \
  169.     *(recno_t *)p = nrecs;                        \
  170.     p += sizeof(recno_t);                        \
  171.     *(pgno_t *)p = pgno;                        \
  172. }
  173.  
  174. /* For the btree leaf pages, the item is a key and data pair. */
  175. typedef struct _bleaf {
  176.     u_int32_t    ksize;        /* size of key */
  177.     u_int32_t    dsize;        /* size of data */
  178.     u_char    flags;            /* P_BIGDATA, P_BIGKEY */
  179.     char    bytes[1];        /* data */
  180. } BLEAF;
  181.  
  182. /* Get the page's BLEAF structure at index indx. */
  183. #define    GETBLEAF(pg, indx)                        \
  184.     ((BLEAF *)((char *)(pg) + (pg)->linp[indx]))
  185.  
  186. /* Get the number of bytes in the entry. */
  187. #define NBLEAF(p)    NBLEAFDBT((p)->ksize, (p)->dsize)
  188.  
  189. /* Get the number of bytes in the user's key/data pair. */
  190. #define NBLEAFDBT(ksize, dsize)                        \
  191.     LALIGN(sizeof(u_int32_t) + sizeof(u_int32_t) + sizeof(u_char) +    \
  192.         (ksize) + (dsize))
  193.  
  194. /* Copy a BLEAF entry to the page. */
  195. #define    WR_BLEAF(p, key, data, flags) {                    \
  196.     *(u_int32_t *)p = key->size;                    \
  197.     p += sizeof(u_int32_t);                        \
  198.     *(u_int32_t *)p = data->size;                    \
  199.     p += sizeof(u_int32_t);                        \
  200.     *(u_char *)p = flags;                        \
  201.     p += sizeof(u_char);                        \
  202.     memmove(p, key->data, key->size);                \
  203.     p += key->size;                            \
  204.     memmove(p, data->data, data->size);                \
  205. }
  206.  
  207. /* For the recno leaf pages, the item is a data entry. */
  208. typedef struct _rleaf {
  209.     u_int32_t    dsize;        /* size of data */
  210.     u_char    flags;            /* P_BIGDATA */
  211.     char    bytes[1];
  212. } RLEAF;
  213.  
  214. /* Get the page's RLEAF structure at index indx. */
  215. #define    GETRLEAF(pg, indx)                        \
  216.     ((RLEAF *)((char *)(pg) + (pg)->linp[indx]))
  217.  
  218. /* Get the number of bytes in the entry. */
  219. #define NRLEAF(p)    NRLEAFDBT((p)->dsize)
  220.  
  221. /* Get the number of bytes from the user's data. */
  222. #define    NRLEAFDBT(dsize)                        \
  223.     LALIGN(sizeof(u_int32_t) + sizeof(u_char) + (dsize))
  224.  
  225. /* Copy a RLEAF entry to the page. */
  226. #define    WR_RLEAF(p, data, flags) {                    \
  227.     *(u_int32_t *)p = data->size;                    \
  228.     p += sizeof(u_int32_t);                        \
  229.     *(u_char *)p = flags;                        \
  230.     p += sizeof(u_char);                        \
  231.     memmove(p, data->data, data->size);                \
  232. }
  233.  
  234. /*
  235.  * A record in the tree is either a pointer to a page and an index in the page
  236.  * or a page number and an index.  These structures are used as a cursor, stack
  237.  * entry and search returns as well as to pass records to other routines.
  238.  *
  239.  * One comment about searches.  Internal page searches must find the largest
  240.  * record less than key in the tree so that descents work.  Leaf page searches
  241.  * must find the smallest record greater than key so that the returned index
  242.  * is the record's correct position for insertion.
  243.  */
  244. typedef struct _epgno {
  245.     pgno_t    pgno;            /* the page number */
  246.     indx_t    index;            /* the index on the page */
  247. } EPGNO;
  248.  
  249. typedef struct _epg {
  250.     PAGE    *page;            /* the (pinned) page */
  251.     indx_t     index;            /* the index on the page */
  252. } EPG;
  253.  
  254. /*
  255.  * About cursors.  The cursor (and the page that contained the key/data pair
  256.  * that it referenced) can be deleted, which makes things a bit tricky.  If
  257.  * there are no duplicates of the cursor key in the tree (i.e. B_NODUPS is set
  258.  * or there simply aren't any duplicates of the key) we copy the key that it
  259.  * referenced when it's deleted, and reacquire a new cursor key if the cursor
  260.  * is used again.  If there are duplicates keys, we move to the next/previous
  261.  * key, and set a flag so that we know what happened.  NOTE: if duplicate (to
  262.  * the cursor) keys are added to the tree during this process, it is undefined
  263.  * if they will be returned or not in a cursor scan.
  264.  *
  265.  * The flags determine the possible states of the cursor:
  266.  *
  267.  * CURS_INIT    The cursor references *something*.
  268.  * CURS_ACQUIRE    The cursor was deleted, and a key has been saved so that
  269.  *        we can reacquire the right position in the tree.
  270.  * CURS_AFTER, CURS_BEFORE
  271.  *        The cursor was deleted, and now references a key/data pair
  272.  *        that has not yet been returned, either before or after the
  273.  *        deleted key/data pair.
  274.  * XXX
  275.  * This structure is broken out so that we can eventually offer multiple
  276.  * cursors as part of the DB interface.
  277.  */
  278. typedef struct _cursor {
  279.     EPGNO     pg;            /* B: Saved tree reference. */
  280.     DBT     key;            /* B: Saved key, or key.data == NULL. */
  281.     recno_t     rcursor;        /* R: recno cursor (1-based) */
  282.  
  283. #define    CURS_ACQUIRE    0x01        /*  B: Cursor needs to be reacquired. */
  284. #define    CURS_AFTER    0x02        /*  B: Unreturned cursor after key. */
  285. #define    CURS_BEFORE    0x04        /*  B: Unreturned cursor before key. */
  286. #define    CURS_INIT    0x08        /* RB: Cursor initialized. */
  287.     u_int8_t flags;
  288. } CURSOR;
  289.  
  290. /*
  291.  * The metadata of the tree.  The nrecs field is used only by the RECNO code.
  292.  * This is because the btree doesn't really need it and it requires that every
  293.  * put or delete call modify the metadata.
  294.  */
  295. typedef struct _btmeta {
  296.     u_int32_t    magic;        /* magic number */
  297.     u_int32_t    version;    /* version */
  298.     u_int32_t    psize;        /* page size */
  299.     u_int32_t    free;        /* page number of first free page */
  300.     u_int32_t    nrecs;        /* R: number of records */
  301.  
  302. #define    SAVEMETA    (B_NODUPS | R_RECNO)
  303.     u_int32_t    flags;        /* bt_flags & SAVEMETA */
  304. } BTMETA;
  305.  
  306. /* The in-memory btree/recno data structure. */
  307. typedef struct _btree {
  308.     MPOOL     *bt_mp;        /* memory pool cookie */
  309.  
  310.     DB     *bt_dbp;        /* pointer to enclosing DB */
  311.  
  312.     EPG      bt_cur;        /* current (pinned) page */
  313.     PAGE     *bt_pinned;        /* page pinned across calls */
  314.  
  315.     CURSOR      bt_cursor;        /* cursor */
  316.  
  317. #define    BT_PUSH(t, p, i) {                        \
  318.     t->bt_sp->pgno = p;                         \
  319.     t->bt_sp->index = i;                         \
  320.     ++t->bt_sp;                            \
  321. }
  322. #define    BT_POP(t)    (t->bt_sp == t->bt_stack ? NULL : --t->bt_sp)
  323. #define    BT_CLR(t)    (t->bt_sp = t->bt_stack)
  324.     EPGNO      bt_stack[50];        /* stack of parent pages */
  325.     EPGNO     *bt_sp;        /* current stack pointer */
  326.  
  327.     DBT      bt_rkey;        /* returned key */
  328.     DBT      bt_rdata;        /* returned data */
  329.  
  330.     int      bt_fd;        /* tree file descriptor */
  331.  
  332.     pgno_t      bt_free;        /* next free page */
  333.     u_int32_t bt_psize;        /* page size */
  334.     indx_t      bt_ovflsize;        /* cut-off for key/data overflow */
  335.     int      bt_lorder;        /* byte order */
  336.                     /* sorted order */
  337.     enum { NOT, BACK, FORWARD } bt_order;
  338.     EPGNO      bt_last;        /* last insert */
  339.  
  340.                     /* B: key comparison function */
  341.     int    (*bt_cmp) __P((const DBT *, const DBT *));
  342.                     /* B: prefix comparison function */
  343.     size_t    (*bt_pfx) __P((const DBT *, const DBT *));
  344.                     /* R: recno input function */
  345.     int    (*bt_irec) __P((struct _btree *, recno_t));
  346.  
  347.     FILE     *bt_rfp;        /* R: record FILE pointer */
  348.     int      bt_rfd;        /* R: record file descriptor */
  349.  
  350.     caddr_t      bt_cmap;        /* R: current point in mapped space */
  351.     caddr_t      bt_smap;        /* R: start of mapped space */
  352.     caddr_t   bt_emap;        /* R: end of mapped space */
  353.     size_t      bt_msize;        /* R: size of mapped region. */
  354.  
  355.     recno_t      bt_nrecs;        /* R: number of records */
  356.     size_t      bt_reclen;        /* R: fixed record length */
  357.     u_char      bt_bval;        /* R: delimiting byte/pad character */
  358.  
  359. /*
  360.  * NB:
  361.  * B_NODUPS and R_RECNO are stored on disk, and may not be changed.
  362.  */
  363. #define    B_INMEM        0x00001        /* in-memory tree */
  364. #define    B_METADIRTY    0x00002        /* need to write metadata */
  365. #define    B_MODIFIED    0x00004        /* tree modified */
  366. #define    B_NEEDSWAP    0x00008        /* if byte order requires swapping */
  367. #define    B_RDONLY    0x00010        /* read-only tree */
  368.  
  369. #define    B_NODUPS    0x00020        /* no duplicate keys permitted */
  370. #define    R_RECNO        0x00080        /* record oriented tree */
  371.  
  372. #define    R_CLOSEFP    0x00040        /* opened a file pointer */
  373. #define    R_EOF        0x00100        /* end of input file reached. */
  374. #define    R_FIXLEN    0x00200        /* fixed length records */
  375. #define    R_MEMMAPPED    0x00400        /* memory mapped file. */
  376. #define    R_INMEM        0x00800        /* in-memory file */
  377. #define    R_MODIFIED    0x01000        /* modified file */
  378. #define    R_RDONLY    0x02000        /* read-only file */
  379.  
  380. #define    B_DB_LOCK    0x04000        /* DB_LOCK specified. */
  381. #define    B_DB_SHMEM    0x08000        /* DB_SHMEM specified. */
  382. #define    B_DB_TXN    0x10000        /* DB_TXN specified. */
  383.     u_int32_t flags;
  384. } BTREE;
  385.  
  386. #if PRAGMA_ALIGN_SUPPORTED
  387. #pragma options align=reset
  388. #endif
  389.  
  390. #include "btree_extern.h"
  391.